home *** CD-ROM | disk | FTP | other *** search
/ Technotools / Technotools (Chestnut CD-ROM)(1993).ISO / os2tools / prxutils / prxutils.inf (.txt) < prev    next >
OS/2 Help File  |  1992-06-28  |  64KB  |  2,497 lines
  1.  
  2. ΓòÉΓòÉΓòÉ 1. Introduction ΓòÉΓòÉΓòÉ
  3.  
  4. OS/2 PRXUTILS Dynamic Link Library Reference 
  5. Version 1.00
  6. (c) Copyright Pedagogic Software 1992.  All rights reserved.
  7. Licensed to AMR, Inc. and all subsidiaries (no fee required).
  8. Program and Documentation by 
  9. W. David Ashley 
  10.  
  11. No warranties, guarantees, etc. are implied, and no liability is assumed for 
  12. the code, examples, DLLs, or documentation. 
  13.  
  14. This software is user-supported software and may be freely copied and used by 
  15. anyone who wishes to do so as long as the following conditions are met: 
  16.  
  17.  1. These functions may not be used by any program for which a fee is charged 
  18.     unless the owner of the program has paid the registration fee. 
  19.  
  20.  2. If you transmit a copy of this software to another party you must give them 
  21.     the complete unaltered contents of the PRXUTILS.ZIP file. 
  22.  
  23.  3. If you make any modifications to these functions you must change the name 
  24.     of the dynamic link library file PRXUTILS.DLL to some other name. 
  25.  
  26. If you feel that this program has benefited you, please register it by sending 
  27. $25.00 (no fee required by AMR, Inc. and all subsidiaries) to: 
  28.  
  29. Pedagogic Software 
  30. W. David Ashley 
  31. 5 Timberline Dr. 
  32. Trophy Club, Tx 76262 
  33. USA 
  34.  
  35. The source code for PRXUTILS can be obtained by sending $75.00 ($25.00 
  36. registration + $50.00 source code) to the same address (no fee required by AMR, 
  37. Inc. and all subsidiaries). 
  38.  
  39. If you have questions, comments or suggestions please contact me at the address 
  40. above (AMR employees may contact me through PROFS, my user ID is Z2277). 
  41.  
  42. DESCRIPTION 
  43.  
  44. PRXUTILS is a Dynamic Link Library (DLL) which provides the OS/2 REXX 
  45. programmer with many versatile functions which augment the OS/2 2.0 system 
  46. supplied REXXUTIL.DLL library. It is a full 32-bit DLL compiled with IBM's C 
  47. SET/2 compiler using Developer's Workbench for OS/2 2.0. 
  48.  
  49. The functionality in this library is continuation of the development begun with 
  50. Pedagogic Software's REXXUTIL library for OS/2 1.x.  Since IBM has chosen to 
  51. release their version of REXXUTIL.DLL we have eliminated the duplicate 
  52. functionality from PRXUTILS and added additional functions not found in our 
  53. original REXXUTIL library. 
  54.  
  55. BEFORE YOU BEGIN 
  56.  
  57. Before you begin to use this reference, it would be helpful to understand how 
  58. you can: 
  59.  
  60. o Expand the Contents window to see all available topics 
  61. o Obtain additional information for a highlighted word or phrase 
  62. o Use action bar choices. 
  63.  
  64. HOW TO USE THE CONTENTS 
  65.  
  66. When the Contents window is first displayed, some topics have a plus (+) sign 
  67. beside them.  The plus sign indicates that additional topics are available. 
  68.  
  69. To expand the Contents window if you are using a mouse, click on the plus sign. 
  70. If you are using the keyboard, use the Up Arrow () or Down Arrow () key to 
  71. highlight the topic and press the Plus (+) key.  For example, Introduction has 
  72. a plus sign beside it. To see the complete list of topics, click on the plus 
  73. sign or highlight that topic and press the Plus key. 
  74.  
  75. To view a topic, double-click on the topic (or press the Up Arrow or Down Arrow 
  76. key to highlight the topic and then press the Enter key). 
  77.  
  78. HOW TO OBTAIN ADDITIONAL INFORMATION 
  79.  
  80. After you select a topic, the information for that topic is displayed in a 
  81. window.  Highlighted words or phrases indicate that additional information is 
  82. available. You will notice that certain words in the following section are 
  83. highlighted. If you are using a mouse, double-click on the highlighted word. If 
  84. you are using a keyboard, press the Tab key to move to the highlighted word and 
  85. then press the Enter key. Additional information will be displayed in a pop-up 
  86. window. 
  87.  
  88. In addition, some topics contain graphic elements which may be highlighted. 
  89. These elements allow you to select the next or previous topic for viewing. The 
  90. same technique described above is also used to select the graphic elements. 
  91.  
  92. HOW TO USE ACTION BAR CHOICES 
  93.  
  94. A number of choices are available for managing information presented in this 
  95. reference. If you want to see more information about these choices, 
  96. double-click on the name of the choice (or press the Tab key to move to the 
  97. choice and press the Enter key). 
  98.  
  99. Bookmark    Allows you to set a placeholder so you can retrieve information of 
  100.             interest to you. (This choice is available from the Services 
  101.             pull-down.) 
  102.  
  103. Search      Allows you to find occurrences of a word or phrase in the current 
  104.             topic, selected topics, or all topics.  (This choice is available 
  105.             from the Services pull-down.) 
  106.  
  107. Print       Allows you to print one or more topics. (This choice is available 
  108.             from the Services pull-down.) 
  109.  
  110. Copy        Allows you to copy a topic you are viewing to a file you can edit. 
  111.             (This choice is available from the Services pull-down.) 
  112.  
  113. Options     Allows you to change the way your Contents window is displayed. 
  114.  
  115. TRADEMARKS 
  116.  
  117. The following trademarks apply to this reference: 
  118.  
  119. o IBM is a registered trademark of International Business Machines Corporation. 
  120.  
  121. o Operating System/2 and OS/2 are trademarks of International Business Machines 
  122.   Corporation. 
  123.  
  124. o Personal System/2 and PS/2 are trademarks of International Business Machines 
  125.   Corporation. 
  126.  
  127. o REXX/2 is a trademark of International Business Machines Corporation. 
  128.  
  129. o C Set/2 is a trademark of International Business Machines Corporation. 
  130.  
  131. o Developer's Workbench is a trademark of International Business Machines 
  132.   Corporation. 
  133.  
  134.  
  135. ΓòÉΓòÉΓòÉ 1.1. Requirements ΓòÉΓòÉΓòÉ
  136.  
  137. PRXUTILS requires that you are already running under the following environment: 
  138.  
  139. o OS/2 2.0 
  140.  
  141. PRXUTILS was developed and tested using the final releases of IBM OS/2 2.0, IBM 
  142. C Set/2, and the IBM Developer's Workbench for OS/2 2.0. 
  143.  
  144. PRXUTILS will not function on any version of OS/2 1.x. 
  145.  
  146.  
  147. ΓòÉΓòÉΓòÉ 1.2. Installation ΓòÉΓòÉΓòÉ
  148.  
  149. Copy the PRXUTILS.DLL file to a directory specified in your LIBPATH. 
  150.  
  151. Note:  If you have a previous copy of PRXUTILS loaded and OS/2 cannot 
  152. open/replace the file then a copy of the DLL currently resides in memory. 
  153. Reboot and before executing any REXX/2 cmds that reference PRXUTILS copy the 
  154. file to your LIBPATH destination. 
  155.  
  156.  
  157. ΓòÉΓòÉΓòÉ 1.3. Usage ΓòÉΓòÉΓòÉ
  158.  
  159. PRXUTILS is an external function package. To be able to use a PRXUTILS function 
  160. in a REXX/2 cmd, you must first register the function via the REXX function 
  161. RxFuncAdd. 
  162.  
  163. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PrxLoadFuncs'
  164.  
  165. The above example would add the PrxLoadFuncs function so that it can be used. 
  166. The first argument specifies how you wish to refer to the function in you 
  167. program (its name in the REXX program). The second argument references the name 
  168. of the PRXUTILS.DLL library (always 'PRXUTILS'). And the third argument 
  169. references the name of the entry point in the library which contains the code 
  170. for the function (the name always referenced in this manual when refering to a 
  171. PRXUTILS function). 
  172.  
  173. To drop the function when the application is done execute the following REXX 
  174. function: 
  175.  
  176. call RxFuncDrop 'PrxLoadFuncs'
  177.  
  178. The function name now becomes unknown to the REXX/2 interpreter in all OS/2 
  179. processes and will generate a runtime error if used after this point in the 
  180. program. 
  181.  
  182. Refer to IBM Operating System/2 Procedures Language 2/REXX Reference manual for 
  183. more information on the RxFuncAdd and RxFuncDrop statements. 
  184.  
  185. Note:  The case of the strings passed to RxFuncAdd and RxFuncDrop are not 
  186. important. The strings will be converted to all upper case by the REXX/2 
  187. interpreter automatically. 
  188.  
  189.  
  190. ΓòÉΓòÉΓòÉ 2. How to Read the Syntax Diagrams ΓòÉΓòÉΓòÉ
  191.  
  192. The syntax diagrams shows you how to specify a function so that REXX/2 can 
  193. correctly interpret what you type. Read the syntax diagram from left to right 
  194. and from top to bottom, starting at the ΓöÇ symbol, following the horizontal 
  195. line (the main path). A line ending with an ΓöÇ means that the command syntax is 
  196. continued.  A line starting with an ΓöÇ means that the syntax is continued from 
  197. the previous line. The ΓöÇ symbol marks the end of the function syntax. 
  198. Required parameters are displayed on the main path; optional parameters are 
  199. displayed below it. 
  200.  
  201. Parameters are classified as constants or variables. String constants must be 
  202. delimited by the standard REXX/2 quotation marks. A function name is a keyword. 
  203. REXX/2 functions may be either CALLed or referenced as a function entry. Some 
  204. of the external functions presented here do not return any values. 
  205.  
  206. Variables appear in lowercase letters and represent names or values you supply. 
  207. Include all punctuation shown in the diagram, such as colons, semicolons, 
  208. commas, quotation marks, and equal signs. 
  209.  
  210. Optional Parameters: Optional parameters appear below the main syntax trace 
  211. line. If specified they must appear in the order listed. 
  212.  
  213. Example: 
  214.  
  215.  
  216.  ΓöÇΓöÇCALL PrxCopy srcfilespec, destfilespecΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇ
  217.                                              ΓööΓöÇΓöÇ, optionΓöÇΓöÇΓöÿ
  218.  
  219.  
  220. ΓòÉΓòÉΓòÉ 3. Function Overview ΓòÉΓòÉΓòÉ
  221.  
  222. The descriptions of all functions in the PRXUTILS package follow. They are 
  223. grouped by their function (file system functions, macro functions, etc.). They 
  224. are listed in alphabetical order within their function group. 
  225.  
  226. The function groups are listed below: 
  227.  
  228. o Miscellaneous Functions 
  229. o Date Manipulation Functions 
  230. o File System Functions 
  231. o REXX/2 Macrospace Functions 
  232. o VIO Interface Functions 
  233.  
  234.  
  235. ΓòÉΓòÉΓòÉ 3.1. Miscellaneous Functions ΓòÉΓòÉΓòÉ
  236.  
  237. These functions are miscellaneous in nature. 
  238.  
  239. The functions in this group are: 
  240.  
  241. o PrxLoadFuncs 
  242. o PrxDropFuncs 
  243. o PrxUtilVersion 
  244.  
  245.  
  246. ΓòÉΓòÉΓòÉ 3.1.1. PrxDropFuncs ΓòÉΓòÉΓòÉ
  247.  
  248. Select one: 
  249.  
  250. Syntax 
  251. Parameters 
  252. Return Values 
  253. Notes 
  254. Example 
  255.  
  256.  
  257. ΓòÉΓòÉΓòÉ <hidden> Syntax - PrxDropFuncs ΓòÉΓòÉΓòÉ
  258.  
  259.  
  260.  ΓöÇΓöÇcall PrxDropFuncsΓöÇΓöÇ
  261.  
  262.  
  263. ΓòÉΓòÉΓòÉ <hidden> Parameters - PrxDropFuncs ΓòÉΓòÉΓòÉ
  264.  
  265. None. 
  266.  
  267.  
  268. ΓòÉΓòÉΓòÉ <hidden> Return Values - PrxDropFuncs ΓòÉΓòÉΓòÉ
  269.  
  270. Always returns a zero-length string. 
  271.  
  272.  
  273. ΓòÉΓòÉΓòÉ <hidden> Notes - PrxDropFuncs ΓòÉΓòÉΓòÉ
  274.  
  275. Drops all of the functions in the PRXUTILS.DLL from REXX. After this call all 
  276. of PRXUTILS's functions will become unknown to the interpreter, including this 
  277. function. 
  278.  
  279.  
  280. ΓòÉΓòÉΓòÉ <hidden> Example - PrxDropFuncs ΓòÉΓòÉΓòÉ
  281.  
  282. /* add all PRXUTILS functions */
  283. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PRXLOADFUNCS'
  284. call PrxLoadFuncs
  285.  
  286. /* drop all of PRXUTILS's functions */
  287. call PrxDropFuncs
  288. say 'Functions dropped.'
  289.  
  290.  
  291. ΓòÉΓòÉΓòÉ 3.1.2. PrxLoadFuncs ΓòÉΓòÉΓòÉ
  292.  
  293. Select one: 
  294.  
  295. Syntax 
  296. Parameters 
  297. Return Values 
  298. Notes 
  299. Example 
  300.  
  301.  
  302. ΓòÉΓòÉΓòÉ <hidden> Syntax - PrxLoadFuncs ΓòÉΓòÉΓòÉ
  303.  
  304.  
  305.  ΓöÇΓöÇcall PrxLoadFuncsΓöÇΓöÇ
  306.  
  307.  
  308. ΓòÉΓòÉΓòÉ <hidden> Parameters - PrxLoadFuncs ΓòÉΓòÉΓòÉ
  309.  
  310. None. 
  311.  
  312.  
  313. ΓòÉΓòÉΓòÉ <hidden> Return Values - PrxLoadFuncs ΓòÉΓòÉΓòÉ
  314.  
  315. Always returns a zero-length string. 
  316.  
  317.  
  318. ΓòÉΓòÉΓòÉ <hidden> Notes - PrxLoadFuncs ΓòÉΓòÉΓòÉ
  319.  
  320. Registers all of the functions in the PRXUTILS.DLL package to REXX. 
  321.  
  322.  
  323. ΓòÉΓòÉΓòÉ <hidden> Example - PrxLoadFuncs ΓòÉΓòÉΓòÉ
  324.  
  325. /* add all PRXUTILS functions */
  326. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PRXLOADFUNCS'
  327. call PrxLoadFuncs
  328. say 'Functions loaded.'
  329.  
  330.  
  331. ΓòÉΓòÉΓòÉ 3.1.3. PrexUtilsVersion ΓòÉΓòÉΓòÉ
  332.  
  333. Select one: 
  334.  
  335. Syntax 
  336. Parameters 
  337. Return Values 
  338. Notes 
  339. Example 
  340.  
  341.  
  342. ΓòÉΓòÉΓòÉ <hidden> Syntax - PrxUtilsVersion ΓòÉΓòÉΓòÉ
  343.  
  344.  
  345.  ΓöÇΓöÇver = PrxUtilsVersion()ΓöÇΓöÇ
  346.  
  347.  
  348. ΓòÉΓòÉΓòÉ <hidden> Parameters - PrxUtilsVersion ΓòÉΓòÉΓòÉ
  349.  
  350. None. 
  351.  
  352.  
  353. ΓòÉΓòÉΓòÉ <hidden> Return Values - PrxUtilsVersion ΓòÉΓòÉΓòÉ
  354.  
  355. Value     Definition 
  356.  
  357. ver       String containing PRXUTILS version info in the form 'x.xx mmm 
  358.           [d]d,yyyy' where 
  359.  
  360.    o x.xx is the version number 
  361.    o mmm is the month of compliation 
  362.    o dd is the day of compilation (1 or 2 characters) 
  363.    o yyyy is the year of compliation 
  364.  
  365.  
  366. ΓòÉΓòÉΓòÉ <hidden> Notes - PrxUtilsVersion ΓòÉΓòÉΓòÉ
  367.  
  368. Returns the version of the PRXUTILS.DLL which is currently running. 
  369.  
  370.  
  371. ΓòÉΓòÉΓòÉ <hidden> Example - PrxUtilsVersion ΓòÉΓòÉΓòÉ
  372.  
  373. /* add all PRXUTILS functions */
  374. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PRXLOADFUNCS'
  375. call PrxLoadFuncs
  376.  
  377. util_version = substr(PrxUtilsVersion(), 1, 4)
  378. util_compdate = substr(PrxUtilsVersion(), 6)
  379.  
  380.  
  381. ΓòÉΓòÉΓòÉ 3.2. Date Manipulation Functions ΓòÉΓòÉΓòÉ
  382.  
  383. These functions manipulate standard REXX/2 date. 
  384.  
  385. The functions in this group are: 
  386.  
  387. o PrxBaseToDate 
  388. o PrxDateToBase 
  389.  
  390.  
  391. ΓòÉΓòÉΓòÉ 3.2.1. PrxBaseToDate ΓòÉΓòÉΓòÉ
  392.  
  393. Select one: 
  394.  
  395. Syntax 
  396. Parameters 
  397. Return Values 
  398. Notes 
  399. Example 
  400.  
  401.  
  402. ΓòÉΓòÉΓòÉ <hidden> Syntax - PrxBaseToDate ΓòÉΓòÉΓòÉ
  403.  
  404.  
  405.  ΓöÇfmtdate = PrxBaseToDateDate(basedate)ΓöÇΓöÇ
  406.  
  407.  or
  408.  
  409.  ΓöÇfmtdate = PrxBaseToDateDate(basedate, fmtstr)ΓöÇΓöÇ
  410.  
  411.  
  412. ΓòÉΓòÉΓòÉ <hidden> Parameters - PrxBaseToDate ΓòÉΓòÉΓòÉ
  413.  
  414. Parm           Definition 
  415.  
  416. basedate       The base date to be converted. 
  417.  
  418. fmtstr         (Optional) The format specifier for fmtdate. The string should 
  419.                contain one of the following values: 
  420.  
  421.    ''        (Null string) The format of fmtdate will the same as the format 
  422.              returned by the REXX/2 builtin function date(). 
  423.  
  424.    'L'       The format of fmtdate will the same as the format returned by the 
  425.              REXX/2 builtin function date('L'). 
  426.  
  427.    'N'       The format of fmtdate will the same as the format returned by the 
  428.              REXX/2 builtin function date('N'). 
  429.  
  430.    'S'       The format of fmtdate will the same as the format returned by the 
  431.              REXX/2 builtin function date('S'). 
  432.  
  433.                The case of the fmtstr is not important. 
  434.  
  435. Note:  PrxBaseToDate(basedate) is the same as PrxBaseToDate(basedate, ''). 
  436.  
  437.  
  438. ΓòÉΓòÉΓòÉ <hidden> Return Values - PrxBaseToDate ΓòÉΓòÉΓòÉ
  439.  
  440. Value     Definition 
  441.  
  442. ''        (Null string) The conversion was not successful or a parameter was 
  443.           not correct. 
  444.  
  445. fmtdate   The formatted date string corresponding to the fmtstr. 
  446.  
  447.  
  448. ΓòÉΓòÉΓòÉ <hidden> Notes - PrxBaseToDate ΓòÉΓòÉΓòÉ
  449.  
  450. Converts a string containing a standard REXX/2 basedate data type (the same 
  451. format as the REXX/2 date('b') builtin function returns) to the specified 
  452. formated date type. 
  453.  
  454.  
  455. ΓòÉΓòÉΓòÉ <hidden> Example - PrxBaseToDate ΓòÉΓòÉΓòÉ
  456.  
  457. /* add all PRXUTILS functions */
  458. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PRXLOADFUNCS'
  459. call PrxLoadFuncs
  460.  
  461. /* format a base date to the specified format */
  462. fmtdate = RexBaseToDate(725975)
  463. /* fmtdate = '27 Aug 1988' */
  464.  
  465.  
  466. ΓòÉΓòÉΓòÉ 3.2.2. PrxDateToBase ΓòÉΓòÉΓòÉ
  467.  
  468. Select one: 
  469.  
  470. Syntax 
  471. Parameters 
  472. Return Values 
  473. Notes 
  474. Example 
  475.  
  476.  
  477. ΓòÉΓòÉΓòÉ <hidden> Syntax - PrxDateToBase ΓòÉΓòÉΓòÉ
  478.  
  479.  
  480.  ΓöÇΓöÇbasedate = PrxDateToBase(datestr)ΓöÇΓöÇ
  481.  
  482.  or
  483.  
  484.  ΓöÇΓöÇbasedate = PrxDateToBase(datestr, fmtstr)ΓöÇΓöÇ
  485.  
  486.  
  487. ΓòÉΓòÉΓòÉ <hidden> Parameters - PrxDateToBase ΓòÉΓòÉΓòÉ
  488.  
  489. Parm           Definition 
  490.  
  491. datestr        The formated date string to be converted. 
  492.  
  493. fmtstr         (Optional) The format specifier for datestr. The string should 
  494.                contain one of the following values: 
  495.  
  496.    ''        (Null string) The format of datestr is the same as the format 
  497.              returned by the REXX/2 builtin function date(). 
  498.  
  499.    'L'       The format of datestr is the same as the format returned by the 
  500.              REXX/2 builtin function date('L'). 
  501.  
  502.    'N'       The format of datestr is the same as the format returned by the 
  503.              REXX/2 builtin function date('N'). 
  504.  
  505.    'S'       The format of datestr is the same as the format returned by the 
  506.              REXX/2 builtin function date('S'). 
  507.  
  508.                The case of the fmtstr is not important. 
  509.  
  510. Note:  PrxDateToBase(datestr) is the same as PrxDateToBase(datestr, ''). 
  511.  
  512.  
  513. ΓòÉΓòÉΓòÉ <hidden> Return Values - PrxDateToBase ΓòÉΓòÉΓòÉ
  514.  
  515. Value     Definition 
  516.  
  517. ''        (Null string) The conversion was not successful or a parameter was 
  518.           not correct. 
  519.  
  520. basedate  The basedate corresponding to the datestr. 
  521.  
  522.  
  523. ΓòÉΓòÉΓòÉ <hidden> Notes - PrxDateToBase ΓòÉΓòÉΓòÉ
  524.  
  525. Converts a string containing a formated date to the standard REXX/2 basedate 
  526. data type (the same format as the REXX/2 date('b') builtin function returns). 
  527.  
  528.  
  529. ΓòÉΓòÉΓòÉ <hidden> Example - PrxDateToBase ΓòÉΓòÉΓòÉ
  530.  
  531. /* add all PRXUTILS functions */
  532. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PRXLOADFUNCS'
  533. call PrxLoadFuncs
  534.  
  535. /* get the base date of the specified input date */
  536. basedate = RexDateToBase('27 Aug 1988')
  537. /* basedate = 725975 */
  538.  
  539.  
  540. ΓòÉΓòÉΓòÉ 3.3. File System Functions ΓòÉΓòÉΓòÉ
  541.  
  542. These functions operate on the OS/2 file system. 
  543.  
  544. The functions in this group are: 
  545.  
  546. o PrxCopyFile 
  547. o PrxReadToStem 
  548. o PrxMoveFile 
  549. o PrxWriteFromStem 
  550.  
  551.  
  552. ΓòÉΓòÉΓòÉ 3.3.1. PrxCopyFile ΓòÉΓòÉΓòÉ
  553.  
  554. Select one: 
  555.  
  556. Syntax 
  557. Parameters 
  558. Return Values 
  559. Notes 
  560. Example 
  561.  
  562.  
  563. ΓòÉΓòÉΓòÉ <hidden> Syntax - PrxCopyFile ΓòÉΓòÉΓòÉ
  564.  
  565.  
  566.  ΓöÇΓöÇCALL PrxCopyFile srcfilespec, destfilespecΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇ
  567.                                                  ΓööΓöÇΓöÇ, optionΓöÇΓöÇΓöÿ
  568.  
  569.  or
  570.  
  571.  ΓöÇΓöÇreturn_code = PrxCopyFile(srcfilespec, destfilespecΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇ)ΓöÇΓöÇ
  572.                                                           ΓööΓöÇΓöÇ, optionΓöÇΓöÇΓöÿ
  573.  
  574.  
  575. ΓòÉΓòÉΓòÉ <hidden> Parameters - PrxCopyFile ΓòÉΓòÉΓòÉ
  576.  
  577. Parm                Definition 
  578.  
  579. srcfilespec         Source file specification which could include wildcards. 
  580.                     The parameter is NOT case sensitive to REXX/2, but the 
  581.                     supplied case will be used by OS/2. 
  582.  
  583. destfilespec        Destination file specification which could include 
  584.                     wildcards. The parameter is NOT case sensitive to REXX/2, 
  585.                     but the supplied case will be used by OS/2. 
  586.  
  587. option              Copy option. 
  588.  
  589.    'Append'     Append source file(s) to the end of the specified destination 
  590.                 file(s) if they exist or to create them if they do not. If this 
  591.                 option is not present the default is to create/replace the 
  592.                 destination file(s). 
  593.  
  594.                 The parameter is NOT case sensitive and only the first letter 
  595.                 of the option is significant. 
  596.  
  597.  
  598. ΓòÉΓòÉΓòÉ <hidden> Return Values - PrxCopyFile ΓòÉΓòÉΓòÉ
  599.  
  600. Returns the return code from OS/2 DosCopy() system API. Some of the possible 
  601. return codes are: 
  602.  
  603. Value     Definition 
  604.  
  605. 2         ERROR_FILE_NOT_FOUND 
  606.  
  607. 3         ERROR_PATH_NOT_FOUND 
  608.  
  609. 5         ERROR_ACCESS_DENIED 
  610.  
  611. 26        ERROR_NOT_DOS_DISK 
  612.  
  613. 32        ERROR_SHARING_VIOLATION 
  614.  
  615. 36        ERROR_SHARING_BUFFER_EXCEEDED 
  616.  
  617. 108       ERROR_DRIVE_LOCKED 
  618.  
  619. 112       ERROR_DISK_FULL 
  620.  
  621. 206       ERROR_FILENAME_EXCED_RANGE 
  622.  
  623. 267       ERROR_ACCESS_DIRECTORY 
  624.  
  625.  
  626. ΓòÉΓòÉΓòÉ <hidden> Notes - PrxCopyFile ΓòÉΓòÉΓòÉ
  627.  
  628. Copy file(s) to the specified destination. All extended attributes are copied 
  629. as well as the file contents. If the target disk subsystem does not support 
  630. extended attributes then they are not copied. 
  631.  
  632.  
  633. ΓòÉΓòÉΓòÉ <hidden> Example - PrxCopyFile ΓòÉΓòÉΓòÉ
  634.  
  635. /* add all PRXUTILS functions */
  636. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PRXLOADFUNCS'
  637. call PrxLoadFuncs
  638.  
  639. /* copy all files from c:\temp to c:\work */
  640. dest = 'c:\work'
  641. return_code = PrxCopyFile('c:\temp\*.*', dest)
  642.  
  643.  
  644. ΓòÉΓòÉΓòÉ 3.3.2. PrxMoveFile ΓòÉΓòÉΓòÉ
  645.  
  646. Select one: 
  647.  
  648. Syntax 
  649. Parameters 
  650. Return Values 
  651. Notes 
  652. Example 
  653.  
  654.  
  655. ΓòÉΓòÉΓòÉ <hidden> Syntax - PrxMoveFile ΓòÉΓòÉΓòÉ
  656.  
  657.  
  658.  ΓöÇΓöÇCALL PrxMoveFile oldfilename, newfilenameΓöÇΓöÇ
  659.  
  660.  or
  661.  
  662.  ΓöÇΓöÇretc = PrxMoveFile(oldfilename, newfilename)ΓöÇΓöÇ
  663.  
  664.  
  665. ΓòÉΓòÉΓòÉ <hidden> Parameters - PrxMoveFile ΓòÉΓòÉΓòÉ
  666.  
  667. Parm                Definition 
  668.  
  669. oldfilename         The name of the file or directory to move/rename. The 
  670.                     parameter is NOT case sensitive to REXX/2, but the supplied 
  671.                     case will be used by OS/2. 
  672.  
  673. newfilename         The new name of the file or directory. The parameter is NOT 
  674.                     case sensitive to REXX/2, but the supplied case will be 
  675.                     used by OS/2. 
  676.  
  677.  
  678. ΓòÉΓòÉΓòÉ <hidden> Return Values - PrxMoveFile ΓòÉΓòÉΓòÉ
  679.  
  680. Returns the return code from the OS/2 DosMove() API. Some of the possible 
  681. return codes are: 
  682.  
  683. Value     Definition 
  684.  
  685. 2         ERROR_FILE_NOT_FOUND 
  686.  
  687. 3         ERROR_PATH_NOT_FOUND 
  688.  
  689. 5         ERROR_ACCESS_DENIED 
  690.  
  691. 17        ERROR_NOT_SAME_DEVICE 
  692.  
  693. 26        ERROR_NOT_DOS_DISK 
  694.  
  695. 32        ERROR_SHARING_VIOLATION 
  696.  
  697. 36        ERROR_SHARING_BUFFER_EXCEEDED 
  698.  
  699. 108       ERROR_DRIVE_LOCKED 
  700.  
  701.  
  702. ΓòÉΓòÉΓòÉ <hidden> Notes - PrxMoveFile ΓòÉΓòÉΓòÉ
  703.  
  704. Move/rename specified file(s) or directory(s) which could include wildcards. 
  705.  
  706.  
  707. ΓòÉΓòÉΓòÉ <hidden> Example - PrxMoveFile ΓòÉΓòÉΓòÉ
  708.  
  709. /* add all PRXUTILS functions */
  710. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PRXLOADFUNCS'
  711. call PrxLoadFuncs
  712.  
  713. call PrxMoveFile 'c:\config.sys', 'config.old'
  714.  
  715.  
  716. ΓòÉΓòÉΓòÉ 3.3.3. PrxReadToStem ΓòÉΓòÉΓòÉ
  717.  
  718. Select one: 
  719.  
  720. Syntax 
  721. Parameters 
  722. Return Values 
  723. Notes 
  724. Example 
  725.  
  726.  
  727. ΓòÉΓòÉΓòÉ <hidden> Syntax - PrxReadToStem ΓòÉΓòÉΓòÉ
  728.  
  729.  
  730.  ΓöÇΓöÇCALL PrxReadToStem filename, stemΓöÇΓöÇ
  731.  
  732.  or
  733.  
  734.  ΓöÇΓöÇreturn_code = PrxReadToStem(filename, stem)ΓöÇΓöÇ
  735.  
  736.  
  737. ΓòÉΓòÉΓòÉ <hidden> Parameters - PrxReadToStem ΓòÉΓòÉΓòÉ
  738.  
  739. Parm           Definition 
  740.  
  741. filename       The name of the file to read. The parameter is NOT case 
  742.                sensitive. 
  743.  
  744. stem           A constant or expression that evaluates to the name of the stem 
  745.                to place the file in. 
  746.  
  747.                Note:  stem.0 will contain the number of lines read. 
  748.  
  749.  
  750. ΓòÉΓòÉΓòÉ <hidden> Return Values - PrxReadToStem ΓòÉΓòÉΓòÉ
  751.  
  752. Value     Definition 
  753.  
  754. '0'       The file was read to the specified stem variables successfully. 
  755.  
  756.           Note:  stem.0 is valid only on this return code. 
  757.  
  758. '1'       Memory error. 
  759.  
  760. '2'       REXX variable pool error. 
  761.  
  762. '3'       Error opening or reading the file. 
  763.  
  764.  
  765. ΓòÉΓòÉΓòÉ <hidden> Notes - PrxReadToStem ΓòÉΓòÉΓòÉ
  766.  
  767. Reads a specified file into a stem variable. The maximum input line is 
  768. restricted to 999 characters. If the input line is longer than 999 characters 
  769. then it will be split physically as many times as necessary into successive 
  770. stem variables. 
  771.  
  772.  
  773. ΓòÉΓòÉΓòÉ <hidden> Example - PrxReadToStem ΓòÉΓòÉΓòÉ
  774.  
  775. /* add all PRXUTILS functions */
  776. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PRXLOADFUNCS'
  777. call PrxLoadFuncs
  778.  
  779. call PrxReadToStem 'c:\config.sys', 'file'
  780. say 'The number of lines in the file is' file.0'.'
  781. say 'The listing of the file follows:'
  782. do num = 1 to file.0
  783.    say file.num
  784.    end
  785.  
  786.  
  787. ΓòÉΓòÉΓòÉ 3.3.4. PrxWriteFromStem ΓòÉΓòÉΓòÉ
  788.  
  789. Select one: 
  790.  
  791. Syntax 
  792. Parameters 
  793. Return Values 
  794. Notes 
  795. Example 
  796.  
  797.  
  798. ΓòÉΓòÉΓòÉ <hidden> Syntax - PrxWriteFromStem ΓòÉΓòÉΓòÉ
  799.  
  800.  
  801.  ΓöÇΓöÇCALL PrxWriteFromStem filename, stem, numΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇ
  802.                                                 ΓööΓöÇΓöÇ, startΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
  803.                                                             ΓööΓöÇΓöÇ, optΓöÇΓöÇΓöÿ
  804.  
  805.  or
  806.  
  807.  ΓöÇΓöÇretc = PrxWriteFromStem(filename, stem, numΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇ)ΓöÇΓöÇ
  808.                                                   ΓööΓöÇΓöÇ, startΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
  809.                                                               ΓööΓöÇΓöÇ, optΓöÇΓöÇΓöÿ
  810.  
  811.  
  812. ΓòÉΓòÉΓòÉ <hidden> Parameters - PrxWriteFromStem ΓòÉΓòÉΓòÉ
  813.  
  814. Parm           Definition 
  815.  
  816. filename       The name of the file to write. The parameter is NOT case 
  817.                sensitive. 
  818.  
  819. stem           A constant or expression that evaluates to the name of the file 
  820.                stem variable containing the lines to be written. 
  821.  
  822. num            The number of lines to write (usually stem.0) 
  823.  
  824. start          (optional) The line number to start with.  The default is 1. 
  825.  
  826. opt            (optional) Any one of the following: 
  827.  
  828.    'Append'       Append the stem variables to the specified file.  Create a 
  829.                   new file if the specified file does not exist. 
  830.    'Replace'      (default) Replace the file specified with the stem 
  831.                   variable(s). Create a new file if specified file does not 
  832.                   exist. 
  833.  
  834.                The parameter is NOT case sensitive and only the first letter of 
  835.                the option is significant. 
  836.  
  837.  
  838. ΓòÉΓòÉΓòÉ <hidden> Return Values - PrxWriteFromStem ΓòÉΓòÉΓòÉ
  839.  
  840. Value     Definition 
  841.  
  842. '0'       The specified stem variables were written to the file successfully. 
  843.  
  844. '1'       Memory error. 
  845.  
  846. '2'       REXX variable pool error. 
  847.  
  848. '3'       Error opening or writing the file. 
  849.  
  850.  
  851. ΓòÉΓòÉΓòÉ <hidden> Notes - PrxWriteFromStem ΓòÉΓòÉΓòÉ
  852.  
  853. Writes a specified file stem variable array to a specified file. 
  854.  
  855.  
  856. ΓòÉΓòÉΓòÉ <hidden> Example - PrxWriteFromStem ΓòÉΓòÉΓòÉ
  857.  
  858. /* add all PRXUTILS functions */
  859. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PRXLOADFUNCS'
  860. call PrxLoadFuncs
  861.  
  862. file.1 = 'First line to be written.'
  863. file.2 = 'Second line.'
  864. file.3 = 'Last line to be written.'
  865. file.0 = 3
  866. call PrxWriteFromStem 'c:\output.txt', 'file', file.0, 1, 'A'
  867. /* 3 lines have been appended to the file 'c:\output.txt' */
  868.  
  869.  
  870. ΓòÉΓòÉΓòÉ 3.4. REXX/2 Macrospace Manipulation Functions ΓòÉΓòÉΓòÉ
  871.  
  872. These functions manipulate the REXX/2 macrospace. 
  873.  
  874. The functions in this group are: 
  875.  
  876. o PrxMacroDrop 
  877. o PrxMacroErase 
  878. o PrxMacroLibDir 
  879. o PrxMacroLoad 
  880. o PrxMacroQuery 
  881. o PrxMacroReOrder 
  882. o PrxMacroSave 
  883.  
  884.  
  885. ΓòÉΓòÉΓòÉ 3.4.1. PrxMacroDrop ΓòÉΓòÉΓòÉ
  886.  
  887. Select one: 
  888.  
  889. Syntax 
  890. Parameters 
  891. Return Values 
  892. Notes 
  893. Example 
  894.  
  895.  
  896. ΓòÉΓòÉΓòÉ <hidden> Syntax - PrxMacroDrop ΓòÉΓòÉΓòÉ
  897.  
  898.  
  899.  ΓöÇΓöÇretc = PrxMacroDrop(funcname)ΓöÇΓöÇ
  900.  
  901.  
  902. ΓòÉΓòÉΓòÉ <hidden> Parameters - PrxMacroDrop ΓòÉΓòÉΓòÉ
  903.  
  904. Parm           Definition 
  905.  
  906. funcname       Name of the Macrospace function to drop. 
  907.  
  908.  
  909. ΓòÉΓòÉΓòÉ <hidden> Return Values - PrxMacroDrop ΓòÉΓòÉΓòÉ
  910.  
  911. Value     Definition 
  912.  
  913. 0         Function successfully dropped from the Macrospace. 
  914.  
  915. 2         Function not found in the Macrospace. 
  916.  
  917.  
  918. ΓòÉΓòÉΓòÉ <hidden> Notes - PrxMacroDrop ΓòÉΓòÉΓòÉ
  919.  
  920. Drops the specified function from the REXX/2 Macrospace. 
  921.  
  922.  
  923. ΓòÉΓòÉΓòÉ <hidden> Example - PrxMacroDrop ΓòÉΓòÉΓòÉ
  924.  
  925. /* add all PRXUTILS functions */
  926. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PRXLOADFUNCS'
  927. call PrxLoadFuncs
  928.  
  929. /* drop the function 'TestIt' from the REXX/2 Macrospace */
  930. retc = PrxMacroDrop('testit')
  931.  
  932.  
  933. ΓòÉΓòÉΓòÉ 3.4.2. PrxMacroErase ΓòÉΓòÉΓòÉ
  934.  
  935. Select one: 
  936.  
  937. Syntax 
  938. Parameters 
  939. Return Values 
  940. Notes 
  941. Example 
  942.  
  943.  
  944. ΓòÉΓòÉΓòÉ <hidden> Syntax - PrxMacroErase ΓòÉΓòÉΓòÉ
  945.  
  946.  
  947.  ΓöÇΓöÇretc = PrxMacroErase()ΓöÇΓöÇ
  948.  
  949.  
  950. ΓòÉΓòÉΓòÉ <hidden> Parameters - PrxMacroErase ΓòÉΓòÉΓòÉ
  951.  
  952. None. 
  953.  
  954.  
  955. ΓòÉΓòÉΓòÉ <hidden> Return Values - PrxMacroErase ΓòÉΓòÉΓòÉ
  956.  
  957. Value     Definition 
  958.  
  959. 0         Macrospace successfully cleared. 
  960.  
  961. 2         Macrospace is currently empty. 
  962.  
  963.  
  964. ΓòÉΓòÉΓòÉ <hidden> Notes - PrxMacroErase ΓòÉΓòÉΓòÉ
  965.  
  966. Drops all functions unconditionally from the REXX/2 Macrospace. 
  967.  
  968. Note:  Be very careful in the use of this function. The REXX/2 Macrospace is 
  969. global to all threads, tasks, and screen groups in OS/2. Functions will be 
  970. dropped even though other tasks may be currently using them. 
  971.  
  972.  
  973. ΓòÉΓòÉΓòÉ <hidden> Example - PrxMacroErase ΓòÉΓòÉΓòÉ
  974.  
  975. /* add all PRXUTILS functions */
  976. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PRXLOADFUNCS'
  977. call PrxLoadFuncs
  978.  
  979. /* erase all functions from the Macrospace */
  980. retc = PrxMacroErase()
  981.  
  982.  
  983. ΓòÉΓòÉΓòÉ 3.4.3. PrxMacroLibDir ΓòÉΓòÉΓòÉ
  984.  
  985. Select one: 
  986.  
  987. Syntax 
  988. Parameters 
  989. Return Values 
  990. Notes 
  991. Example 
  992.  
  993.  
  994. ΓòÉΓòÉΓòÉ <hidden> Syntax - PrxMacroLibDir ΓòÉΓòÉΓòÉ
  995.  
  996.  
  997.  ΓöÇΓöÇretc = PrxMacroLibDir(filename, stem)ΓöÇΓöÇ
  998.  
  999.  
  1000. ΓòÉΓòÉΓòÉ <hidden> Parameters - PrxMacroLibDir ΓòÉΓòÉΓòÉ
  1001.  
  1002. Parm           Definition 
  1003.  
  1004. filename       The name of the REXX/2 Macro Library file. The parameter is NOT 
  1005.                case sensitive. 
  1006.  
  1007. stem           A constant or expression that evaluates to the name of the stem 
  1008.                variable to place the function directory. The format of each 
  1009.                function directory entry is 
  1010.  
  1011.     1. Function size in bytes - 8 characters 
  1012.     2. 1 blank character 
  1013.     3. Function search position - 6 characters 
  1014.     4. 1 blank character 
  1015.     5. Function name - up to 255 characters 
  1016.  
  1017. Note:  stem.0 will contain the number of function entries in the library on a 
  1018. successful return from PrxMacroLibDir. 
  1019.  
  1020.  
  1021. ΓòÉΓòÉΓòÉ <hidden> Return Values - PrxMacroLibDir ΓòÉΓòÉΓòÉ
  1022.  
  1023. Value     Definition 
  1024.  
  1025. '0'       File read was successful. 
  1026.  
  1027.           Note:  stem.0 is valid only on this return code. 
  1028.  
  1029. '1'       Memory error. 
  1030.  
  1031. '2'       REXX variable pool error. 
  1032.  
  1033. '5'       File open or read error. 
  1034.  
  1035.  
  1036. ΓòÉΓòÉΓòÉ <hidden> Notes - PrxMacroLibDir ΓòÉΓòÉΓòÉ
  1037.  
  1038. Reads the Function Directory of a REXX/2 Macro Library file into a stem 
  1039. variable. 
  1040.  
  1041.  
  1042. ΓòÉΓòÉΓòÉ <hidden> Example - PrxMacroLibDir ΓòÉΓòÉΓòÉ
  1043.  
  1044. /* add all PRXUTILS functions */
  1045. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PRXLOADFUNCS'
  1046. call PrxLoadFuncs
  1047.  
  1048. retc = PrxMacroLibDir('mylib.rxl', 'func')
  1049. if retc = 0 then do
  1050.    say 'The number of function entries is' func.0'.'
  1051.    say 'The function directory follows:'
  1052.    do num = 1 to func.0
  1053.       say func.num
  1054.       end
  1055.    end
  1056. else say 'Invalid return code. Return code =' retc
  1057.  
  1058.  
  1059. ΓòÉΓòÉΓòÉ 3.4.4. PrxMacroLoad ΓòÉΓòÉΓòÉ
  1060.  
  1061. Select one: 
  1062.  
  1063. Syntax 
  1064. Parameters 
  1065. Return Values 
  1066. Notes 
  1067. Example 
  1068.  
  1069.  
  1070. ΓòÉΓòÉΓòÉ <hidden> Syntax - PrxMacroLoad ΓòÉΓòÉΓòÉ
  1071.  
  1072.  
  1073.  ΓöÇΓöÇretc = PrxMacroLoad(filename)ΓöÇΓöÇ
  1074.  
  1075.  or
  1076.  
  1077.  ΓöÇΓöÇretc = PrxMacroLoad(filename, fname, srch)ΓöÇΓöÇ
  1078.  
  1079.  
  1080. ΓòÉΓòÉΓòÉ <hidden> Parameters - PrxMacroLoad ΓòÉΓòÉΓòÉ
  1081.  
  1082. Parm           Definition 
  1083.  
  1084. filename       REXX/2 Macro Library or REXX/2 function file name. The parameter 
  1085.                is NOT case sensitive. 
  1086.  
  1087. fname          Function name to give to the Macrospace function. 
  1088.  
  1089. srch           Either of the following literal strings to specify the search 
  1090.                order position of the function: 
  1091.  
  1092.    'BEFORE'       Load function at beginning of Macrospace search list. 
  1093.  
  1094.    'AFTER'        Load function at end of Macrospace search list. 
  1095.  
  1096.                The parameter is NOT case sensitive. 
  1097.  
  1098.  
  1099. ΓòÉΓòÉΓòÉ <hidden> Return Values - PrxMacroLoad ΓòÉΓòÉΓòÉ
  1100.  
  1101. Value     Definition 
  1102.  
  1103. 0         Function(s) successfully loaded. 
  1104.  
  1105. 1         No memory storage available or memory error. 
  1106.  
  1107. 2         Macro function not found. 
  1108.  
  1109. 4         Macro function already exists in Macrospace. None of the specified 
  1110.           functions have been loaded. 
  1111.  
  1112. 5         Macro file error. 
  1113.  
  1114. 6         Macro library file signature error. 
  1115.  
  1116. 7         Macro function source file not found. 
  1117.  
  1118. 8         Invalid search position specified. 
  1119.  
  1120.  
  1121. ΓòÉΓòÉΓòÉ <hidden> Notes - PrxMacroLoad ΓòÉΓòÉΓòÉ
  1122.  
  1123. Loads either a REXX/2 Macro Library or a REXX/2 Function to the REXX/2 
  1124. Macrospace. The 1 argument version loads all functions from a REXX/2 Macrospace 
  1125. Library and the 3 argument version loads a REXX/2 command file as a function. 
  1126.  
  1127.  
  1128. ΓòÉΓòÉΓòÉ <hidden> Example - PrxMacroLoad ΓòÉΓòÉΓòÉ
  1129.  
  1130. /* add all PRXUTILS functions */
  1131. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PRXLOADFUNCS'
  1132. call PrxLoadFuncs
  1133.  
  1134. /* load a single REXX/2 function file into the Macrospace */
  1135. retc = PrxMacroLoad('func.cmd', 'myfunc', 'BEFORE')
  1136.  
  1137.  
  1138. ΓòÉΓòÉΓòÉ 3.4.5. PrxMacroQuery ΓòÉΓòÉΓòÉ
  1139.  
  1140. Select one: 
  1141.  
  1142. Syntax 
  1143. Parameters 
  1144. Return Values 
  1145. Notes 
  1146. Example 
  1147.  
  1148.  
  1149. ΓòÉΓòÉΓòÉ <hidden> Syntax - PrxMacroQuery ΓòÉΓòÉΓòÉ
  1150.  
  1151.  
  1152.  ΓöÇΓöÇretc = PrxMacroQuery(funcname)ΓöÇΓöÇ
  1153.  
  1154.  
  1155. ΓòÉΓòÉΓòÉ <hidden> Parameters - PrxMacroQuery ΓòÉΓòÉΓòÉ
  1156.  
  1157. Parm           Definition 
  1158.  
  1159. funcname       Function name in the Macrospace to be searched for. 
  1160.  
  1161.  
  1162. ΓòÉΓòÉΓòÉ <hidden> Return Values - PrxMacroQuery ΓòÉΓòÉΓòÉ
  1163.  
  1164. Value     Definition 
  1165.  
  1166. 0         Function not found. 
  1167.  
  1168. 1         Function found. Search order for the function is 'BEFORE'. 
  1169.  
  1170. 2         Function found. Search order for the function is 'AFTER'. 
  1171.  
  1172.  
  1173. ΓòÉΓòÉΓòÉ <hidden> Notes - PrxMacroQuery ΓòÉΓòÉΓòÉ
  1174.  
  1175. Queries the REXX/2 Macrospace for the existence of a function. 
  1176.  
  1177.  
  1178. ΓòÉΓòÉΓòÉ <hidden> Example - PrxMacroQuery ΓòÉΓòÉΓòÉ
  1179.  
  1180. /* add all PRXUTILS functions */
  1181. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PRXLOADFUNCS'
  1182. call PrxLoadFuncs
  1183.  
  1184. /* query Macrospace for function 'myfunc' */
  1185. retc = PrxMacroQuery('myfunc')
  1186.  
  1187.  
  1188. ΓòÉΓòÉΓòÉ 3.4.6. PrxMacroReOrder ΓòÉΓòÉΓòÉ
  1189.  
  1190. Select one: 
  1191.  
  1192. Syntax 
  1193. Parameters 
  1194. Return Values 
  1195. Notes 
  1196. Example 
  1197.  
  1198.  
  1199. ΓòÉΓòÉΓòÉ <hidden> Syntax - PrxMacroReOrder ΓòÉΓòÉΓòÉ
  1200.  
  1201.  
  1202.  ΓöÇΓöÇretc = PrxMacroReOrder(fname, srch)ΓöÇΓöÇ
  1203.  
  1204.  
  1205. ΓòÉΓòÉΓòÉ <hidden> Parameters - PrxMacroReOrder ΓòÉΓòÉΓòÉ
  1206.  
  1207. Parm           Definition 
  1208.  
  1209. fname          Function name in the Macrospace to be altered. 
  1210.  
  1211. srch           Either of the following literal strings to specify the search 
  1212.                order position of the function: 
  1213.  
  1214.    'BEFORE'       Set function at beginning of Macrospace search list. 
  1215.  
  1216.    'AFTER'        Set function at end of Macrospace search list. 
  1217.  
  1218.                The parameter is NOT case sensitive. 
  1219.  
  1220.  
  1221. ΓòÉΓòÉΓòÉ <hidden> Return Values - PrxMacroReOrder ΓòÉΓòÉΓòÉ
  1222.  
  1223. Value     Definition 
  1224.  
  1225. 0         Function search option successfully altered. 
  1226.  
  1227. 2         Function not found. 
  1228.  
  1229. 8         Invalid search option specified. 
  1230.  
  1231.  
  1232. ΓòÉΓòÉΓòÉ <hidden> Notes - PrxMacroReOrder ΓòÉΓòÉΓòÉ
  1233.  
  1234. Adjusts the search order position of the specified function in the REXX/2 
  1235. Macrospace. 
  1236.  
  1237.  
  1238. ΓòÉΓòÉΓòÉ <hidden> Example - PrxMacroReOrder ΓòÉΓòÉΓòÉ
  1239.  
  1240. /* add all PRXUTILS functions */
  1241. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PRXLOADFUNCS'
  1242. call PrxLoadFuncs
  1243.  
  1244. /* adjust search position of function 'myfunc' */
  1245. retc = PrxMacroReOrder('myfunc', 'AFTER')
  1246.  
  1247.  
  1248. ΓòÉΓòÉΓòÉ 3.4.7. PrxMacroSave ΓòÉΓòÉΓòÉ
  1249.  
  1250. Select one: 
  1251.  
  1252. Syntax 
  1253. Parameters 
  1254. Return Values 
  1255. Notes 
  1256. Example 
  1257.  
  1258.  
  1259. ΓòÉΓòÉΓòÉ <hidden> Syntax - PrxMacroSave ΓòÉΓòÉΓòÉ
  1260.  
  1261.  
  1262.  ΓöÇΓöÇretc = PrxMacroSave(filename)ΓöÇΓöÇ
  1263.  
  1264.  
  1265. ΓòÉΓòÉΓòÉ <hidden> Parameters - PrxMacroSave ΓòÉΓòÉΓòÉ
  1266.  
  1267. Parm           Definition 
  1268.  
  1269. filename       Name of the file in which to save the Macrospace. The parameter 
  1270.                is NOT case sensitive. 
  1271.  
  1272.  
  1273. ΓòÉΓòÉΓòÉ <hidden> Return Values - PrxMacroSave ΓòÉΓòÉΓòÉ
  1274.  
  1275. Value     Definition 
  1276.  
  1277. 0         Function saved in the specified file. 
  1278.  
  1279. 2         REXX/2 Macrospace is empty, no functions loaded or saved. 
  1280.  
  1281. 3         An extension is required on the specified filename. 
  1282.  
  1283. 5         File error. 
  1284.  
  1285.  
  1286. ΓòÉΓòÉΓòÉ <hidden> Notes - PrxMacroSave ΓòÉΓòÉΓòÉ
  1287.  
  1288. Saves the entire REXX/2 Macrospace to the specified filename. 
  1289.  
  1290.  
  1291. ΓòÉΓòÉΓòÉ <hidden> Example - PrxMacroSave ΓòÉΓòÉΓòÉ
  1292.  
  1293. /* add all PRXUTILS functions */
  1294. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PRXLOADFUNCS'
  1295. call PrxLoadFuncs
  1296.  
  1297. /* save all functions in the Macrospace to the file 'myfuncs.rxl' */
  1298. retc = PrxMacroSave('myfuncs.rxl')
  1299.  
  1300.  
  1301. ΓòÉΓòÉΓòÉ 3.5. VIO Interface Functions ΓòÉΓòÉΓòÉ
  1302.  
  1303. These functions call OS/2 system VIO functions to manipulate text screens and 
  1304. windows. 
  1305.  
  1306. The functions in this group are: 
  1307.  
  1308. o PrxGetAnsi 
  1309. o PrxGetCurPos 
  1310. o PrxGetMode 
  1311. o PrxPrtSc 
  1312. o PrxReadCellStr 
  1313. o PrxReadCharStr 
  1314. o PrxScrollDn 
  1315. o PrxScrollLf 
  1316. o PrxScrollRt 
  1317. o PrxScrollUp 
  1318. o PrxSetAnsi 
  1319. o PrxSetCurPos 
  1320. o PrxSetMode 
  1321. o PrxWrtCellStr 
  1322. o PrxWrtCharStr 
  1323. o PrxWrtCharStrAtt 
  1324. o PrxWrtNAttr 
  1325. o PrxWrtNCell 
  1326. o PrxWrtNChar 
  1327. o PrxWrtTTY 
  1328.  
  1329.  
  1330. ΓòÉΓòÉΓòÉ 3.5.1. PrxGetAnsi ΓòÉΓòÉΓòÉ
  1331.  
  1332. Select one: 
  1333.  
  1334. Syntax 
  1335. Parameters 
  1336. Return Values 
  1337. Notes 
  1338. Example 
  1339.  
  1340.  
  1341. ΓòÉΓòÉΓòÉ <hidden> Syntax - PrxGetAnsi ΓòÉΓòÉΓòÉ
  1342.  
  1343.  
  1344.  ΓöÇΓöÇansi_state = PrxGetAnsi()ΓöÇΓöÇ
  1345.  
  1346.  
  1347. ΓòÉΓòÉΓòÉ <hidden> Parameters - PrxGetAnsi ΓòÉΓòÉΓòÉ
  1348.  
  1349. None. 
  1350.  
  1351.  
  1352. ΓòÉΓòÉΓòÉ <hidden> Return Values - PrxGetAnsi ΓòÉΓòÉΓòÉ
  1353.  
  1354. Value     Definition 
  1355.  
  1356. '0'       ANSI processing is disabled. 
  1357.  
  1358. '1'       ANSI processing is enabled. 
  1359.  
  1360.  
  1361. ΓòÉΓòÉΓòÉ <hidden> Notes - PrxGetAnsi ΓòÉΓòÉΓòÉ
  1362.  
  1363. Obtains the current state of the ANSI flag. 
  1364.  
  1365. Note:  This function uses VioGetAnsi(). 
  1366.  
  1367.  
  1368. ΓòÉΓòÉΓòÉ <hidden> Example - PrxGetAnsi ΓòÉΓòÉΓòÉ
  1369.  
  1370. /* add all PRXUTILS functions */
  1371. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PRXLOADFUNCS'
  1372. call PrxLoadFuncs
  1373.  
  1374. /* get the current ansi state */
  1375. ansi_state = PrxGetAnsi()
  1376.  
  1377.  
  1378. ΓòÉΓòÉΓòÉ 3.5.2. PrxGetCurPos ΓòÉΓòÉΓòÉ
  1379.  
  1380. Select one: 
  1381.  
  1382. Syntax 
  1383. Parameters 
  1384. Return Values 
  1385. Notes 
  1386. Example 
  1387.  
  1388.  
  1389. ΓòÉΓòÉΓòÉ <hidden> Syntax - PrxGetCurPos ΓòÉΓòÉΓòÉ
  1390.  
  1391.  
  1392.  ΓöÇΓöÇcurpos = PrxGetCurPos()ΓöÇΓöÇ
  1393.  
  1394.  
  1395. ΓòÉΓòÉΓòÉ <hidden> Parameters - PrxGetCurPos ΓòÉΓòÉΓòÉ
  1396.  
  1397. None. 
  1398.  
  1399.  
  1400. ΓòÉΓòÉΓòÉ <hidden> Return Values - PrxGetCurPos ΓòÉΓòÉΓòÉ
  1401.  
  1402. Value     Definition 
  1403.  
  1404. 'row col' The row position and then the column position as a single string. 
  1405.  
  1406.  
  1407. ΓòÉΓòÉΓòÉ <hidden> Notes - PrxGetCurPos ΓòÉΓòÉΓòÉ
  1408.  
  1409. Obtains the current cursor position. 
  1410.  
  1411. Note:  This function uses VioGetCurPos(). 
  1412.  
  1413.  
  1414. ΓòÉΓòÉΓòÉ <hidden> Example - PrxGetCurPos ΓòÉΓòÉΓòÉ
  1415.  
  1416. /* add all PRXUTILS functions */
  1417. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PRXLOADFUNCS'
  1418. call PrxLoadFuncs
  1419.  
  1420. /* get the current cursor position */
  1421. curpos = PrxGetCurPos()
  1422. parse var curpos row column
  1423.  
  1424.  
  1425. ΓòÉΓòÉΓòÉ 3.5.3. PrxGetMode ΓòÉΓòÉΓòÉ
  1426.  
  1427. Select one: 
  1428.  
  1429. Syntax 
  1430. Parameters 
  1431. Return Values 
  1432. Notes 
  1433. Example 
  1434.  
  1435.  
  1436. ΓòÉΓòÉΓòÉ <hidden> Syntax - PrxGetMode ΓòÉΓòÉΓòÉ
  1437.  
  1438.  
  1439.  ΓöÇΓöÇmode = PrxGetMode()ΓöÇΓöÇ
  1440.  
  1441.  
  1442. ΓòÉΓòÉΓòÉ <hidden> Parameters - PrxGetMode ΓòÉΓòÉΓòÉ
  1443.  
  1444. None. 
  1445.  
  1446.  
  1447. ΓòÉΓòÉΓòÉ <hidden> Return Values - PrxGetMode ΓòÉΓòÉΓòÉ
  1448.  
  1449. Value     Definition 
  1450.  
  1451. 'type colors cols rows hres vres' The VIOMODEINFO structure as a single string. 
  1452.  
  1453.  
  1454. ΓòÉΓòÉΓòÉ <hidden> Notes - PrxGetMode ΓòÉΓòÉΓòÉ
  1455.  
  1456. Obtains the current screen mode. 
  1457.  
  1458. Note:  This function uses VioGetMode(). 
  1459.  
  1460.  
  1461. ΓòÉΓòÉΓòÉ <hidden> Example - PrxGetMode ΓòÉΓòÉΓòÉ
  1462.  
  1463. /* add all PRXUTILS functions */
  1464. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PRXLOADFUNCS'
  1465. call PrxLoadFuncs
  1466.  
  1467. /* get the current screen mode */
  1468. mode = PrxGetMode()
  1469. parse var mode type colors cols rows hres vres
  1470.  
  1471.  
  1472. ΓòÉΓòÉΓòÉ 3.5.4. PrxPrtSc ΓòÉΓòÉΓòÉ
  1473.  
  1474. Select one: 
  1475.  
  1476. Syntax 
  1477. Parameters 
  1478. Return Values 
  1479. Notes 
  1480. Example 
  1481.  
  1482.  
  1483. ΓòÉΓòÉΓòÉ <hidden> Syntax - PrxPrtSc ΓòÉΓòÉΓòÉ
  1484.  
  1485.  
  1486.  ΓöÇΓöÇCALL PrxPrtScΓöÇΓöÇ
  1487.  
  1488.  
  1489. ΓòÉΓòÉΓòÉ <hidden> Parameters - PrxPrtSc ΓòÉΓòÉΓòÉ
  1490.  
  1491. None. 
  1492.  
  1493.  
  1494. ΓòÉΓòÉΓòÉ <hidden> Return Values - PrxPrtSc ΓòÉΓòÉΓòÉ
  1495.  
  1496. Always returns '' (null string). 
  1497.  
  1498.  
  1499. ΓòÉΓòÉΓòÉ <hidden> Notes - PrxPrtSc ΓòÉΓòÉΓòÉ
  1500.  
  1501. copies the contents of the screen to the printer. 
  1502.  
  1503. Note:  This function uses VioPrtSc(). 
  1504.  
  1505.  
  1506. ΓòÉΓòÉΓòÉ <hidden> Example - PrxPrtSc ΓòÉΓòÉΓòÉ
  1507.  
  1508. /* add all PRXUTILS functions */
  1509. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PRXLOADFUNCS'
  1510. call PrxLoadFuncs
  1511.  
  1512. /* print the current screen */
  1513. call PrxPrtSc
  1514.  
  1515.  
  1516. ΓòÉΓòÉΓòÉ 3.5.5. PrxReadCellStr ΓòÉΓòÉΓòÉ
  1517.  
  1518. Select one: 
  1519.  
  1520. Syntax 
  1521. Parameters 
  1522. Return Values 
  1523. Notes 
  1524. Example 
  1525.  
  1526.  
  1527. ΓòÉΓòÉΓòÉ <hidden> Syntax - PrxReadCellStr ΓòÉΓòÉΓòÉ
  1528.  
  1529.  
  1530.  ΓöÇΓöÇcstr = PrxReadCellStr(num, row, col)ΓöÇΓöÇ
  1531.  
  1532.  
  1533. ΓòÉΓòÉΓòÉ <hidden> Parameters - PrxReadCellStr ΓòÉΓòÉΓòÉ
  1534.  
  1535. Parm      Definition 
  1536.  
  1537. num       The number of character-attribute pairs to read. 
  1538.  
  1539. row       The starting row position from which to read. 
  1540.  
  1541. col       The starting column position from which to read. 
  1542.  
  1543.  
  1544. ΓòÉΓòÉΓòÉ <hidden> Return Values - PrxReadCellStr ΓòÉΓòÉΓòÉ
  1545.  
  1546. Value     Definition 
  1547.  
  1548. cstr      The character-attribute string. 
  1549.  
  1550.  
  1551. ΓòÉΓòÉΓòÉ <hidden> Notes - PrxReadCellStr ΓòÉΓòÉΓòÉ
  1552.  
  1553. Copies a character-attribute string from the screen from the specified 
  1554. position. 
  1555.  
  1556. Note:  This function uses VioReadCellStr(). 
  1557.  
  1558.  
  1559. ΓòÉΓòÉΓòÉ <hidden> Example - PrxReadCellStr ΓòÉΓòÉΓòÉ
  1560.  
  1561. /* add all PRXUTILS functions */
  1562. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PRXLOADFUNCS'
  1563. call PrxLoadFuncs
  1564.  
  1565. /* get the cell string starting at row 4 column 5 for 20 cells */
  1566. cstr = PrxReadCellStr(20, 4, 5)
  1567.  
  1568.  
  1569. ΓòÉΓòÉΓòÉ 3.5.6. PrxReadCharStr ΓòÉΓòÉΓòÉ
  1570.  
  1571. Select one: 
  1572.  
  1573. Syntax 
  1574. Parameters 
  1575. Return Values 
  1576. Notes 
  1577. Example 
  1578.  
  1579.  
  1580. ΓòÉΓòÉΓòÉ <hidden> Syntax - PrxReadCharStr ΓòÉΓòÉΓòÉ
  1581.  
  1582.  
  1583.  ΓöÇΓöÇcstr = PrxReadCharStr(num, row, col)ΓöÇΓöÇ
  1584.  
  1585.  
  1586. ΓòÉΓòÉΓòÉ <hidden> Parameters - PrxReadCharStr ΓòÉΓòÉΓòÉ
  1587.  
  1588. Parm      Definition 
  1589.  
  1590. num       The number of characters to read. 
  1591.  
  1592. row       The starting row position from which to read. 
  1593.  
  1594. col       The starting column position from which to read. 
  1595.  
  1596.  
  1597. ΓòÉΓòÉΓòÉ <hidden> Return Values - PrxReadCharStr ΓòÉΓòÉΓòÉ
  1598.  
  1599. Value     Definition 
  1600.  
  1601. cstr      The character string. 
  1602.  
  1603.  
  1604. ΓòÉΓòÉΓòÉ <hidden> Notes - PrxReadCharStr ΓòÉΓòÉΓòÉ
  1605.  
  1606. Copies a string (but not its attribute byte) from the screen from the specified 
  1607. position. 
  1608.  
  1609. Note:  This function uses VioReadCharStr(). 
  1610.  
  1611.  
  1612. ΓòÉΓòÉΓòÉ <hidden> Example - PrxReadCharStr ΓòÉΓòÉΓòÉ
  1613.  
  1614. /* add all PRXUTILS functions */
  1615. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PRXLOADFUNCS'
  1616. call PrxLoadFuncs
  1617.  
  1618. /* get the string starting at row 4 column 5 for 20 cells */
  1619. cstr = PrxReadCharStr(20, 4, 5)
  1620.  
  1621.  
  1622. ΓòÉΓòÉΓòÉ 3.5.7. PrxScrollDn ΓòÉΓòÉΓòÉ
  1623.  
  1624. Select one: 
  1625.  
  1626. Syntax 
  1627. Parameters 
  1628. Return Values 
  1629. Notes 
  1630. Example 
  1631.  
  1632.  
  1633. ΓòÉΓòÉΓòÉ <hidden> Syntax - PrxScrollDn ΓòÉΓòÉΓòÉ
  1634.  
  1635.  
  1636.  ΓöÇΓöÇCALL PrxScrollDn top, left, bot, right, numlines, fillΓöÇΓöÇ
  1637.  
  1638.  
  1639. ΓòÉΓòÉΓòÉ <hidden> Parameters - PrxScrollDn ΓòÉΓòÉΓòÉ
  1640.  
  1641. Parm      Definition 
  1642.  
  1643. top       The top line number marking the scroll area (zero-based). 
  1644.  
  1645. left      The left column number marking the scroll area (zero-based). 
  1646.  
  1647. bot       The bottom line number marking the scroll area (zero-based). 
  1648.  
  1649. right     The right column number marking the scroll area (zero-based). 
  1650.  
  1651. numlines  The number of lines to scroll. 
  1652.  
  1653. fill      The fill character-attribute pair to be used. 
  1654.  
  1655.  
  1656. ΓòÉΓòÉΓòÉ <hidden> Return Values - PrxScrollDn ΓòÉΓòÉΓòÉ
  1657.  
  1658. Always returns '' (null string). 
  1659.  
  1660.  
  1661. ΓòÉΓòÉΓòÉ <hidden> Notes - PrxScrollDn ΓòÉΓòÉΓòÉ
  1662.  
  1663. Scrolls the designated area of the screen downward the specified number of 
  1664. lines. 
  1665.  
  1666. Note:  This function uses VioScrollDn(). 
  1667.  
  1668.  
  1669. ΓòÉΓòÉΓòÉ <hidden> Example - PrxScrollDn ΓòÉΓòÉΓòÉ
  1670.  
  1671. /* add all PRXUTILS functions */
  1672. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PRXLOADFUNCS'
  1673. call PrxLoadFuncs
  1674.  
  1675. /* scroll the first 5 lines of the screen down 2 lines */
  1676. /* fill the scrolled area with blanks/white attribute  */
  1677. call PrxScrollDn 0, 0, 4, 79, 2, ' ' || x2c(07)
  1678.  
  1679.  
  1680. ΓòÉΓòÉΓòÉ 3.5.8. PrxScrollLf ΓòÉΓòÉΓòÉ
  1681.  
  1682. Select one: 
  1683.  
  1684. Syntax 
  1685. Parameters 
  1686. Return Values 
  1687. Notes 
  1688. Example 
  1689.  
  1690.  
  1691. ΓòÉΓòÉΓòÉ <hidden> Syntax - PrxScrollLf ΓòÉΓòÉΓòÉ
  1692.  
  1693.  
  1694.  ΓöÇΓöÇCALL PrxScrollLf top, left, bot, right, numchars, fillΓöÇΓöÇ
  1695.  
  1696.  
  1697. ΓòÉΓòÉΓòÉ <hidden> Parameters - PrxScrollLf ΓòÉΓòÉΓòÉ
  1698.  
  1699. Parm      Definition 
  1700.  
  1701. top       The top line number marking the scroll area (zero-based). 
  1702.  
  1703. left      The left column number marking the scroll area (zero-based). 
  1704.  
  1705. bot       The bottom line number marking the scroll area (zero-based). 
  1706.  
  1707. right     The right column number marking the scroll area (zero-based). 
  1708.  
  1709. numlines  The number of characters to scroll. 
  1710.  
  1711. fill      The fill character-attribute pair to be used. 
  1712.  
  1713.  
  1714. ΓòÉΓòÉΓòÉ <hidden> Return Values - PrxScrollLf ΓòÉΓòÉΓòÉ
  1715.  
  1716. Always returns '' (null string). 
  1717.  
  1718.  
  1719. ΓòÉΓòÉΓòÉ <hidden> Notes - PrxScrollLf ΓòÉΓòÉΓòÉ
  1720.  
  1721. Scrolls the designated area of the screen leftward the specified number of 
  1722. characters. 
  1723.  
  1724. Note:  This function uses VioScrollLf(). 
  1725.  
  1726.  
  1727. ΓòÉΓòÉΓòÉ <hidden> Example - PrxScrollLf ΓòÉΓòÉΓòÉ
  1728.  
  1729. /* add all PRXUTILS functions */
  1730. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PRXLOADFUNCS'
  1731. call PrxLoadFuncs
  1732.  
  1733. /* scroll the first 5 lines of the screen left 20 characters */
  1734. /* fill the scrolled area with blanks/white attribute        */
  1735. call PrxScrollLf 0, 0, 4, 79, 20, ' ' || x2c(07)
  1736.  
  1737.  
  1738. ΓòÉΓòÉΓòÉ 3.5.9. PrxScrollRt ΓòÉΓòÉΓòÉ
  1739.  
  1740. Select one: 
  1741.  
  1742. Syntax 
  1743. Parameters 
  1744. Return Values 
  1745. Notes 
  1746. Example 
  1747.  
  1748.  
  1749. ΓòÉΓòÉΓòÉ <hidden> Syntax - PrxScrollRt ΓòÉΓòÉΓòÉ
  1750.  
  1751.  
  1752.  ΓöÇΓöÇCALL PrxScrollRt top, left, bot, right, numchars, fillΓöÇΓöÇ
  1753.  
  1754.  
  1755. ΓòÉΓòÉΓòÉ <hidden> Parameters - PrxScrollRt ΓòÉΓòÉΓòÉ
  1756.  
  1757. Parm      Definition 
  1758.  
  1759. top       The top line number marking the scroll area (zero-based). 
  1760.  
  1761. left      The left column number marking the scroll area (zero-based). 
  1762.  
  1763. bot       The bottom line number marking the scroll area (zero-based). 
  1764.  
  1765. right     The right column number marking the scroll area (zero-based). 
  1766.  
  1767. numlines  The number of characters to scroll. 
  1768.  
  1769. fill      The fill character-attribute pair to be used. 
  1770.  
  1771.  
  1772. ΓòÉΓòÉΓòÉ <hidden> Return Values - PrxScrollRt ΓòÉΓòÉΓòÉ
  1773.  
  1774. Always returns '' (null string). 
  1775.  
  1776.  
  1777. ΓòÉΓòÉΓòÉ <hidden> Notes - PrxScrollRt ΓòÉΓòÉΓòÉ
  1778.  
  1779. Scrolls the designated area of the screen rightward the specified number of 
  1780. characters. 
  1781.  
  1782. Note:  This function uses VioScrollRt(). 
  1783.  
  1784.  
  1785. ΓòÉΓòÉΓòÉ <hidden> Example - PrxScrollRt ΓòÉΓòÉΓòÉ
  1786.  
  1787. /* add all PRXUTILS functions */
  1788. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PRXLOADFUNCS'
  1789. call PrxLoadFuncs
  1790.  
  1791. /* scroll the first 5 lines of the screen right 20 characters */
  1792. /* fill the scrolled area with blanks/white attribute         */
  1793. call PrxScrollRt 0, 0, 4, 79, 20, ' ' || x2c(07)
  1794.  
  1795.  
  1796. ΓòÉΓòÉΓòÉ 3.5.10. PrxScrollUp ΓòÉΓòÉΓòÉ
  1797.  
  1798. Select one: 
  1799.  
  1800. Syntax 
  1801. Parameters 
  1802. Return Values 
  1803. Notes 
  1804. Example 
  1805.  
  1806.  
  1807. ΓòÉΓòÉΓòÉ <hidden> Syntax - PrxScrollUp ΓòÉΓòÉΓòÉ
  1808.  
  1809.  
  1810.  ΓöÇΓöÇCALL PrxScrollUp top, left, bot, right, numlines, fillΓöÇΓöÇ
  1811.  
  1812.  
  1813. ΓòÉΓòÉΓòÉ <hidden> Parameters - PrxScrollUp ΓòÉΓòÉΓòÉ
  1814.  
  1815. Parm      Definition 
  1816.  
  1817. top       The top line number marking the scroll area (zero-based). 
  1818.  
  1819. left      The left column number marking the scroll area (zero-based). 
  1820.  
  1821. bot       The bottom line number marking the scroll area (zero-based). 
  1822.  
  1823. right     The right column number marking the scroll area (zero-based). 
  1824.  
  1825. numlines  The number of lines to scroll. 
  1826.  
  1827. fill      The fill character-attribute pair to be used. 
  1828.  
  1829.  
  1830. ΓòÉΓòÉΓòÉ <hidden> Return Values - PrxScrollUp ΓòÉΓòÉΓòÉ
  1831.  
  1832. Always returns '' (null string). 
  1833.  
  1834.  
  1835. ΓòÉΓòÉΓòÉ <hidden> Notes - PrxScrollUp ΓòÉΓòÉΓòÉ
  1836.  
  1837. Scrolls the designated area of the screen upward the specified number of lines. 
  1838.  
  1839. Note:  This function uses VioScrollUp(). 
  1840.  
  1841.  
  1842. ΓòÉΓòÉΓòÉ <hidden> Example - PrxScrollUp ΓòÉΓòÉΓòÉ
  1843.  
  1844. /* add all PRXUTILS functions */
  1845. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PRXLOADFUNCS'
  1846. call PrxLoadFuncs
  1847.  
  1848. /* scroll the first 5 lines of the screen up 2 lines  */
  1849. /* fill the scrolled area with blanks/white attribute */
  1850. call PrxScrollUp 0, 0, 4, 79, 2, ' ' || x2c(07)
  1851.  
  1852.  
  1853. ΓòÉΓòÉΓòÉ 3.5.11. PrxSetAnsi ΓòÉΓòÉΓòÉ
  1854.  
  1855. Select one: 
  1856.  
  1857. Syntax 
  1858. Parameters 
  1859. Return Values 
  1860. Notes 
  1861. Example 
  1862.  
  1863.  
  1864. ΓòÉΓòÉΓòÉ <hidden> Syntax - PrxSetAnsi ΓòÉΓòÉΓòÉ
  1865.  
  1866.  
  1867.  ΓöÇΓöÇCALL PrxSetAnsi stateΓöÇΓöÇ
  1868.  
  1869.  
  1870. ΓòÉΓòÉΓòÉ <hidden> Parameters - PrxSetAnsi ΓòÉΓòÉΓòÉ
  1871.  
  1872. Parm      Definition 
  1873.  
  1874. '0'       Disable ANSI processing. 
  1875.  
  1876. '1'       Enable ANSI processing. 
  1877.  
  1878.  
  1879. ΓòÉΓòÉΓòÉ <hidden> Return Values - PrxSetAnsi ΓòÉΓòÉΓòÉ
  1880.  
  1881. Always returns '' (null string). 
  1882.  
  1883.  
  1884. ΓòÉΓòÉΓòÉ <hidden> Notes - PrxSetAnsi ΓòÉΓòÉΓòÉ
  1885.  
  1886. Sets the state of the ANSI flag. 
  1887.  
  1888. Note:  This function uses VioSetAnsi(). 
  1889.  
  1890.  
  1891. ΓòÉΓòÉΓòÉ <hidden> Example - PrxSetAnsi ΓòÉΓòÉΓòÉ
  1892.  
  1893. /* add all PRXUTILS functions */
  1894. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PRXLOADFUNCS'
  1895. call PrxLoadFuncs
  1896.  
  1897. /* set the ansi flag */
  1898. call PrxSetAnsi '1'
  1899.  
  1900.  
  1901. ΓòÉΓòÉΓòÉ 3.5.12. PrxSetCurPos ΓòÉΓòÉΓòÉ
  1902.  
  1903. Select one: 
  1904.  
  1905. Syntax 
  1906. Parameters 
  1907. Return Values 
  1908. Notes 
  1909. Example 
  1910.  
  1911.  
  1912. ΓòÉΓòÉΓòÉ <hidden> Syntax - PrxSetCurPos ΓòÉΓòÉΓòÉ
  1913.  
  1914.  
  1915.  ΓöÇΓöÇCALL PrxSetCurPos row, colΓöÇΓöÇ
  1916.  
  1917.  
  1918. ΓòÉΓòÉΓòÉ <hidden> Parameters - PrxSetCurPos ΓòÉΓòÉΓòÉ
  1919.  
  1920. Parm      Definition 
  1921.  
  1922. row       The new row position for the cursor (zero-based). 
  1923.  
  1924. col       The new column position for the cursor (zero-based). 
  1925.  
  1926.  
  1927. ΓòÉΓòÉΓòÉ <hidden> Return Values - PrxSetCurPos ΓòÉΓòÉΓòÉ
  1928.  
  1929. Always returns '' (null string). 
  1930.  
  1931.  
  1932. ΓòÉΓòÉΓòÉ <hidden> Notes - PrxSetCurPos ΓòÉΓòÉΓòÉ
  1933.  
  1934. Sets the current cursor position. 
  1935.  
  1936. Note:  This function uses VioSetCurPos(). 
  1937.  
  1938.  
  1939. ΓòÉΓòÉΓòÉ <hidden> Example - PrxSetCurPos ΓòÉΓòÉΓòÉ
  1940.  
  1941. /* add all PRXUTILS functions */
  1942. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PRXLOADFUNCS'
  1943. call PrxLoadFuncs
  1944.  
  1945. /* set the cursor position to the top left */
  1946. call PrxSetCurPos 0, 0
  1947.  
  1948.  
  1949. ΓòÉΓòÉΓòÉ 3.5.13. PrxSetMode ΓòÉΓòÉΓòÉ
  1950.  
  1951. Select one: 
  1952.  
  1953. Syntax 
  1954. Parameters 
  1955. Return Values 
  1956. Notes 
  1957. Example 
  1958.  
  1959.  
  1960. ΓòÉΓòÉΓòÉ <hidden> Syntax - PrxSetMode ΓòÉΓòÉΓòÉ
  1961.  
  1962.  
  1963.  ΓöÇΓöÇCALL PrxSetMode type, colors, cols, rows, hres, vresΓöÇΓöÇ
  1964.  
  1965.  
  1966. ΓòÉΓòÉΓòÉ <hidden> Parameters - PrxSetMode ΓòÉΓòÉΓòÉ
  1967.  
  1968. Parm      Definition 
  1969.  
  1970. type      The screen mode. 
  1971.  
  1972. colors    The number of colors. 
  1973.  
  1974. cols      The number of text columns. 
  1975.  
  1976. rows      The number of text rows. 
  1977.  
  1978. hres      The number of pel columns. 
  1979.  
  1980. vres      The number of pel rows. 
  1981.  
  1982.  
  1983. ΓòÉΓòÉΓòÉ <hidden> Return Values - PrxSetMode ΓòÉΓòÉΓòÉ
  1984.  
  1985. Always returns '' (null string). 
  1986.  
  1987.  
  1988. ΓòÉΓòÉΓòÉ <hidden> Notes - PrxSetMode ΓòÉΓòÉΓòÉ
  1989.  
  1990. Sets the screen mode. 
  1991.  
  1992. Note:  This function uses VioSetMode(). 
  1993.  
  1994.  
  1995. ΓòÉΓòÉΓòÉ <hidden> Example - PrxSetMode ΓòÉΓòÉΓòÉ
  1996.  
  1997. /* add all PRXUTILS functions */
  1998. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PRXLOADFUNCS'
  1999. call PrxLoadFuncs
  2000.  
  2001. /* get the current screen mode */
  2002. mode = PrxGetMode()
  2003. parse var mode type colors cols rows hres vres
  2004. /* change to 43 line mode */
  2005. call PrxSetMode type, colors, cols, 43, hres, vres
  2006.  
  2007.  
  2008. ΓòÉΓòÉΓòÉ 3.5.14. PrxWrtCellStr ΓòÉΓòÉΓòÉ
  2009.  
  2010. Select one: 
  2011.  
  2012. Syntax 
  2013. Parameters 
  2014. Return Values 
  2015. Notes 
  2016. Example 
  2017.  
  2018.  
  2019. ΓòÉΓòÉΓòÉ <hidden> Syntax - PrxWrtCellStr ΓòÉΓòÉΓòÉ
  2020.  
  2021.  
  2022.  ΓöÇΓöÇCALL PrxWrtCellStr cstr, row, colΓöÇΓöÇ
  2023.  
  2024.  
  2025. ΓòÉΓòÉΓòÉ <hidden> Parameters - PrxWrtCellStr ΓòÉΓòÉΓòÉ
  2026.  
  2027. Parm      Definition 
  2028.  
  2029. cstr      The character-attribute string to write to the screen. 
  2030.  
  2031. row       The row position for the string (zero-based). 
  2032.  
  2033. col       The column position for the string (zero-based). 
  2034.  
  2035.  
  2036. ΓòÉΓòÉΓòÉ <hidden> Return Values - PrxWrtCellStr ΓòÉΓòÉΓòÉ
  2037.  
  2038. Always returns '' (null string). 
  2039.  
  2040.  
  2041. ΓòÉΓòÉΓòÉ <hidden> Notes - PrxWrtCellStr ΓòÉΓòÉΓòÉ
  2042.  
  2043. Write a character-attribute string to the screen at the specified position. 
  2044.  
  2045. Note:  This function uses VioWrtCellStr(). 
  2046.  
  2047.  
  2048. ΓòÉΓòÉΓòÉ <hidden> Example - PrxWrtCellStr ΓòÉΓòÉΓòÉ
  2049.  
  2050. /* add all PRXUTILS functions */
  2051. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PRXLOADFUNCS'
  2052. call PrxLoadFuncs
  2053.  
  2054. /* write cstr to the top left of the screen */
  2055. call PrxWrtCellStr cstr, 0, 0
  2056.  
  2057.  
  2058. ΓòÉΓòÉΓòÉ 3.5.15. PrxWrtCharStr ΓòÉΓòÉΓòÉ
  2059.  
  2060. Select one: 
  2061.  
  2062. Syntax 
  2063. Parameters 
  2064. Return Values 
  2065. Notes 
  2066. Example 
  2067.  
  2068.  
  2069. ΓòÉΓòÉΓòÉ <hidden> Syntax - PrxWrtCharStr ΓòÉΓòÉΓòÉ
  2070.  
  2071.  
  2072.  ΓöÇΓöÇCALL PrxWrtCharStr str, row, colΓöÇΓöÇ
  2073.  
  2074.  
  2075. ΓòÉΓòÉΓòÉ <hidden> Parameters - PrxWrtCharStr ΓòÉΓòÉΓòÉ
  2076.  
  2077. Parm      Definition 
  2078.  
  2079. str       The character string to write to the screen. The current screen 
  2080.           attributes are used. 
  2081.  
  2082. row       The row position for the string (zero-based). 
  2083.  
  2084. col       The column position for the string (zero-based). 
  2085.  
  2086.  
  2087. ΓòÉΓòÉΓòÉ <hidden> Return Values - PrxWrtCharStr ΓòÉΓòÉΓòÉ
  2088.  
  2089. Always returns '' (null string). 
  2090.  
  2091.  
  2092. ΓòÉΓòÉΓòÉ <hidden> Notes - PrxWrtCharStr ΓòÉΓòÉΓòÉ
  2093.  
  2094. Write a character string to the screen at the specified position utilizing the 
  2095. current screen attributes. 
  2096.  
  2097. Note:  This function uses VioWrtCharStr(). 
  2098.  
  2099.  
  2100. ΓòÉΓòÉΓòÉ <hidden> Example - PrxWrtCharStr ΓòÉΓòÉΓòÉ
  2101.  
  2102. /* add all PRXUTILS functions */
  2103. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PRXLOADFUNCS'
  2104. call PrxLoadFuncs
  2105.  
  2106. /* write str to the top left of the screen */
  2107. call PrxWrtCharStr str, 0, 0
  2108.  
  2109.  
  2110. ΓòÉΓòÉΓòÉ 3.5.16. PrxWrtCharStrAtt ΓòÉΓòÉΓòÉ
  2111.  
  2112. Select one: 
  2113.  
  2114. Syntax 
  2115. Parameters 
  2116. Return Values 
  2117. Notes 
  2118. Example 
  2119.  
  2120.  
  2121. ΓòÉΓòÉΓòÉ <hidden> Syntax - PrxWrtCharStrAtt ΓòÉΓòÉΓòÉ
  2122.  
  2123.  
  2124.  ΓöÇΓöÇCALL PrxWrtCharStrAtt str, row, col, attΓöÇΓöÇ
  2125.  
  2126.  
  2127. ΓòÉΓòÉΓòÉ <hidden> Parameters - PrxWrtCharStrAtt ΓòÉΓòÉΓòÉ
  2128.  
  2129. Parm      Definition 
  2130.  
  2131. str       The character string to write to the screen. 
  2132.  
  2133. row       The row position for the string (zero-based). 
  2134.  
  2135. col       The column position for the string (zero-based). 
  2136.  
  2137. att       The attribute for the string. 
  2138.  
  2139.  
  2140. ΓòÉΓòÉΓòÉ <hidden> Return Values - PrxWrtCharStrAtt ΓòÉΓòÉΓòÉ
  2141.  
  2142. Always returns '' (null string). 
  2143.  
  2144.  
  2145. ΓòÉΓòÉΓòÉ <hidden> Notes - PrxWrtCharStrAtt ΓòÉΓòÉΓòÉ
  2146.  
  2147. Write a character string to the screen at the specified position utilizing the 
  2148. specified attribute. 
  2149.  
  2150. Note:  This function uses VioWrtCharStrAtt(). 
  2151.  
  2152.  
  2153. ΓòÉΓòÉΓòÉ <hidden> Example - PrxWrtCharStrAtt ΓòÉΓòÉΓòÉ
  2154.  
  2155. /* add all PRXUTILS functions */
  2156. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PRXLOADFUNCS'
  2157. call PrxLoadFuncs
  2158.  
  2159. /* write str to the top left of the screen */
  2160. /* use green forground, white background   */
  2161. call PrxWrtCharStrAtt str, 0, 0, x2c(72)
  2162.  
  2163.  
  2164. ΓòÉΓòÉΓòÉ 3.5.17. PrxWrtNAttr ΓòÉΓòÉΓòÉ
  2165.  
  2166. Select one: 
  2167.  
  2168. Syntax 
  2169. Parameters 
  2170. Return Values 
  2171. Notes 
  2172. Example 
  2173.  
  2174.  
  2175. ΓòÉΓòÉΓòÉ <hidden> Syntax - PrxWrtNAttr ΓòÉΓòÉΓòÉ
  2176.  
  2177.  
  2178.  ΓöÇΓöÇCALL PrxWrtNAttr attr, num, row, colΓöÇΓöÇ
  2179.  
  2180.  
  2181. ΓòÉΓòÉΓòÉ <hidden> Parameters - PrxWrtNAttr ΓòÉΓòÉΓòÉ
  2182.  
  2183. Parm      Definition 
  2184.  
  2185. attr      The attribute. 
  2186.  
  2187. num       The number of time to write the attribute. 
  2188.  
  2189. row       The start row position (zero-based). 
  2190.  
  2191. col       The start column position (zero-based). 
  2192.  
  2193.  
  2194. ΓòÉΓòÉΓòÉ <hidden> Return Values - PrxWrtNAttr ΓòÉΓòÉΓòÉ
  2195.  
  2196. Always returns '' (null string). 
  2197.  
  2198.  
  2199. ΓòÉΓòÉΓòÉ <hidden> Notes - PrxWrtNAttr ΓòÉΓòÉΓòÉ
  2200.  
  2201. Writes an attribute the specified number of times to the specified screen 
  2202. position. 
  2203.  
  2204. Note:  This function uses VioWrtNAttr(). 
  2205.  
  2206.  
  2207. ΓòÉΓòÉΓòÉ <hidden> Example - PrxWrtNAttr ΓòÉΓòÉΓòÉ
  2208.  
  2209. /* add all PRXUTILS functions */
  2210. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PRXLOADFUNCS'
  2211. call PrxLoadFuncs
  2212.  
  2213. /* write green forground/white background  */
  2214. /* attribute to the top left of the screen */
  2215. /* 60 times                                */
  2216. call PrxWrtNAttr x2c(72), 60, 0, 0
  2217.  
  2218.  
  2219. ΓòÉΓòÉΓòÉ 3.5.18. PrxWrtNCell ΓòÉΓòÉΓòÉ
  2220.  
  2221. Select one: 
  2222.  
  2223. Syntax 
  2224. Parameters 
  2225. Return Values 
  2226. Notes 
  2227. Example 
  2228.  
  2229.  
  2230. ΓòÉΓòÉΓòÉ <hidden> Syntax - PrxWrtNCell ΓòÉΓòÉΓòÉ
  2231.  
  2232.  
  2233.  ΓöÇΓöÇCALL PrxWrtNCell cell, num, row, colΓöÇΓöÇ
  2234.  
  2235.  
  2236. ΓòÉΓòÉΓòÉ <hidden> Parameters - PrxWrtNCell ΓòÉΓòÉΓòÉ
  2237.  
  2238. Parm      Definition 
  2239.  
  2240. cell      The character-attribute to write. 
  2241.  
  2242. num       The number of time to write the cell. 
  2243.  
  2244. row       The start row position (zero-based). 
  2245.  
  2246. col       The start column position (zero-based). 
  2247.  
  2248.  
  2249. ΓòÉΓòÉΓòÉ <hidden> Return Values - PrxWrtNCell ΓòÉΓòÉΓòÉ
  2250.  
  2251. Always returns '' (null string). 
  2252.  
  2253.  
  2254. ΓòÉΓòÉΓòÉ <hidden> Notes - PrxWrtNCell ΓòÉΓòÉΓòÉ
  2255.  
  2256. Write a character-attribute pair to the screen the specified number of times 
  2257. starting at the specified position. 
  2258.  
  2259. Note:  This function uses VioWrtNCell(). 
  2260.  
  2261.  
  2262. ΓòÉΓòÉΓòÉ <hidden> Example - PrxWrtNCell ΓòÉΓòÉΓòÉ
  2263.  
  2264. /* add all PRXUTILS functions */
  2265. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PRXLOADFUNCS'
  2266. call PrxLoadFuncs
  2267.  
  2268. /* write character 'A' with green forground/white background  */
  2269. /* cell to the top left of the screen 60 times                */
  2270. call PrxWrtNCell 'A' || x2c(72), 60, 0, 0
  2271.  
  2272.  
  2273. ΓòÉΓòÉΓòÉ 3.5.19. PrxWrtNChar ΓòÉΓòÉΓòÉ
  2274.  
  2275. Select one: 
  2276.  
  2277. Syntax 
  2278. Parameters 
  2279. Return Values 
  2280. Notes 
  2281. Example 
  2282.  
  2283.  
  2284. ΓòÉΓòÉΓòÉ <hidden> Syntax - PrxWrtNChar ΓòÉΓòÉΓòÉ
  2285.  
  2286.  
  2287.  ΓöÇΓöÇCALL PrxWrtNChar char, num, row, colΓöÇΓöÇ
  2288.  
  2289.  
  2290. ΓòÉΓòÉΓòÉ <hidden> Parameters - PrxWrtNChar ΓòÉΓòÉΓòÉ
  2291.  
  2292. Parm      Definition 
  2293.  
  2294. char      The character to write. 
  2295.  
  2296. num       The number of time to write the character. 
  2297.  
  2298. row       The start row position (zero-based). 
  2299.  
  2300. col       The start column position (zero-based). 
  2301.  
  2302.  
  2303. ΓòÉΓòÉΓòÉ <hidden> Return Values - PrxWrtNChar ΓòÉΓòÉΓòÉ
  2304.  
  2305. Always returns '' (null string). 
  2306.  
  2307.  
  2308. ΓòÉΓòÉΓòÉ <hidden> Notes - PrxWrtNChar ΓòÉΓòÉΓòÉ
  2309.  
  2310. Write a character to the screen the specified number of times starting at the 
  2311. specified position utilizing the current screen attributes. 
  2312.  
  2313. Note:  This function uses VioWrtNChar(). 
  2314.  
  2315.  
  2316. ΓòÉΓòÉΓòÉ <hidden> Example - PrxWrtNChar ΓòÉΓòÉΓòÉ
  2317.  
  2318. /* add all PRXUTILS functions */
  2319. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PRXLOADFUNCS'
  2320. call PrxLoadFuncs
  2321.  
  2322. /* write character 'A' to the top left of the screen 60 times */
  2323. call PrxWrtNChar 'A', 60, 0, 0
  2324.  
  2325.  
  2326. ΓòÉΓòÉΓòÉ 3.5.20. PrxWrtTTY ΓòÉΓòÉΓòÉ
  2327.  
  2328. Select one: 
  2329.  
  2330. Syntax 
  2331. Parameters 
  2332. Return Values 
  2333. Notes 
  2334. Example 
  2335.  
  2336.  
  2337. ΓòÉΓòÉΓòÉ <hidden> Syntax - PrxWrtTTY ΓòÉΓòÉΓòÉ
  2338.  
  2339.  
  2340.  ΓöÇΓöÇCALL PrxWrtTTY strΓöÇΓöÇ
  2341.  
  2342.  
  2343. ΓòÉΓòÉΓòÉ <hidden> Parameters - PrxWrtTTY ΓòÉΓòÉΓòÉ
  2344.  
  2345. Parm      Definition 
  2346.  
  2347. str       The character string to write. 
  2348.  
  2349.  
  2350. ΓòÉΓòÉΓòÉ <hidden> Return Values - PrxWrtTTY ΓòÉΓòÉΓòÉ
  2351.  
  2352. Always returns '' (null string). 
  2353.  
  2354.  
  2355. ΓòÉΓòÉΓòÉ <hidden> Notes - PrxWrtTTY ΓòÉΓòÉΓòÉ
  2356.  
  2357. Write a character string to the screen starting at the current cursor position. 
  2358.  
  2359. Note:  This function uses VioWrtTTY(). 
  2360.  
  2361.  
  2362. ΓòÉΓòÉΓòÉ <hidden> Example - PrxWrtTTY ΓòÉΓòÉΓòÉ
  2363.  
  2364. /* add all PRXUTILS functions */
  2365. call RxFuncAdd 'PrxLoadFuncs', 'PRXUTILS', 'PRXLOADFUNCS'
  2366. call PrxLoadFuncs
  2367.  
  2368. /* write character string to the screen */
  2369. call PrxWrtTTY 'This is a test'
  2370.  
  2371.  
  2372. ΓòÉΓòÉΓòÉ 4. Sample REXX/2 CMD using PRXUTILS ΓòÉΓòÉΓòÉ
  2373.  
  2374. The file REXTEST1.CMD is an example of the use of most of the Miscellaneous and 
  2375. File System functions available in the PRXUTILS.DLL package. 
  2376.  
  2377. The file REXTEST2.CMD is an example of the use of the Date Manipulation 
  2378. Functions available in the PRXUTILS.DLL package. 
  2379.  
  2380. The file REXTEST3.CMD is an example of the use of the REXX/2 Macrospace 
  2381. Manipulation Functions available in the PRXUTILS.DLL package. 
  2382.  
  2383. The file REXTEST4.CMD is an example of the use of the VIO Interface Functions 
  2384. available in the PRXUTILS.DLL package. 
  2385.  
  2386.  
  2387. ΓòÉΓòÉΓòÉ 5. Support of PRXUTILS ΓòÉΓòÉΓòÉ
  2388.  
  2389. Support and enhancements for PRXUTILS will be performed by the author on an "as 
  2390. time permits" basis.  If you have questions, comments or suggestions on 
  2391. improvements the author can be reached at the address below: 
  2392.  
  2393. Pedagogic Software 
  2394. W. David Ashley 
  2395. 5 Timberline Dr. 
  2396. Trophy Club, Tx 76262 
  2397. USA 
  2398.  
  2399. AMR employees may contact me through PROFS, my user ID is Z2277. 
  2400.  
  2401.  
  2402. ΓòÉΓòÉΓòÉ <hidden>  ΓòÉΓòÉΓòÉ
  2403.  
  2404. BookMark 
  2405.  
  2406. When you place a bookmark on a topic, it is added to a list of bookmarks you 
  2407. have previously set. You can view the list, and you can remove one or all 
  2408. bookmarks from the list. If you have not set any bookmarks, the list is empty. 
  2409.  
  2410. To set a bookmark, do the following: 
  2411.  
  2412.  1. Select a topic from the Contents. 
  2413.  
  2414.  2. When that topic appears, choose the Bookmark option from the Services 
  2415.     pull-down. 
  2416.  
  2417.  3. If you want to change the name used for the bookmark, type the new name in 
  2418.     the field. 
  2419.  
  2420.  4. Click on the Place radio button (or press the Up or Down Arrow key to 
  2421.     select it). 
  2422.  
  2423.  5. Click on OK (or select it and press Enter). The bookmark is then added to 
  2424.     the bookmark list. 
  2425.  
  2426.  
  2427. ΓòÉΓòÉΓòÉ <hidden>  ΓòÉΓòÉΓòÉ
  2428.  
  2429. Search 
  2430.  
  2431. You can specify a word or phrase to be searched. You can also limit the search 
  2432. to a set of topics by first marking the topics on the Contents list. 
  2433.  
  2434. To search for a word or phrase in all topics, do the following: 
  2435.  
  2436.  1. Choose the Search option from the Services pull-down. 
  2437.  
  2438.  2. Type the word or words to be searched. 
  2439.  
  2440.  3. Click on All sections (or press the Up or Down Arrow keys to select it). 
  2441.  
  2442.  4. Click on Search (or select it and press Enter) to begin the search. 
  2443.  
  2444.  5. The list of topics where the word or phrase appears is displayed. If only 
  2445.     one topic contains the word or phrase, a window containing that topic 
  2446.     appears. 
  2447.  
  2448.  
  2449. ΓòÉΓòÉΓòÉ <hidden>  ΓòÉΓòÉΓòÉ
  2450.  
  2451. Print 
  2452.  
  2453. You can print one or more topics. You can also print a set of topics by first 
  2454. marking the topics on the Contents list. 
  2455.  
  2456. To print the document Contents list, do the following: 
  2457.  
  2458.  1. Choose Print from the Services pull-down. 
  2459.  
  2460.  2. Click on Contents (or press the Up or Down Arrow to select it). 
  2461.  
  2462.  3. Click on Print (or select it and press Enter). 
  2463.  
  2464.  4. The Contents list is printed on your printer. 
  2465.  
  2466.  
  2467. ΓòÉΓòÉΓòÉ <hidden>  ΓòÉΓòÉΓòÉ
  2468.  
  2469. Copy 
  2470.  
  2471. You can copy a topic you are viewing into a temporary file named TEXT.TMP. You 
  2472. can later edit that file by using the editor of your choice. 
  2473.  
  2474. To copy a topic, do the following: 
  2475.  
  2476.  1. Expand the Contents list and select a topic. 
  2477.  
  2478.  2. When a topic appears, choose Copy to file from the Services pull-down. 
  2479.  
  2480.  3. The system puts the text pertaining to that topic in the temporary TEXT.TMP 
  2481.     file. 
  2482.  
  2483. For information on one of the other choices in the Services pull-down, 
  2484. highlight the choice and press the F1 key. 
  2485.  
  2486.  
  2487. ΓòÉΓòÉΓòÉ <hidden>  ΓòÉΓòÉΓòÉ
  2488.  
  2489. Options 
  2490.  
  2491. You can control the appearance of the Contents list. 
  2492.  
  2493. To expand the Contents and show all levels for all topics, choose Expand all 
  2494. from the Options pull-down. You can also press the Ctrl and * keys together. 
  2495.  
  2496. For information on one of the other choices in the Services pull-down, 
  2497. highlight the choice and press the F1 key.